package com.onlyxiahui.common.action.description.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 
 * Date 2019-01-06 13:41:49<br>
 * Description 参数/字段的名称<br>
 * 
 * @author XiaHui<br>
 * @since 1.0.2
 */
@Target({ ElementType.PARAMETER, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface DocField {

	/**
	 * 
	 * Description name <br>
	 * Date 2020-11-23 09:04:43<br>
	 * 
	 * @return
	 * @since 1.0.2
	 */
	String name() default "";

	/**
	 * 
	 * Description 描述<br>
	 * Date 2020-11-23 09:04:52<br>
	 * 
	 * @return
	 * @since 1.0.2
	 */
	String description() default "";

	/**
	 * 
	 * Description 示例<br>
	 * Date 2020-11-23 09:05:16<br>
	 * 
	 * @return
	 * @since 1.0.2
	 */
	String example() default "";
}